Fix README example and add test to run python-code example in CI#38
Merged
leifdenby merged 13 commits intoSep 17, 2025
Merged
Conversation
Add missing test that ensures that python-code example in README executes without error.
khintz
reviewed
Nov 29, 2024
khintz
left a comment
There was a problem hiding this comment.
Good idea to test the code blocks in the readme.
But you have to be extremely convincing to make me approve without adding an entry to the changelog ;)
joeloskarsson
approved these changes
Nov 29, 2024
Contributor
joeloskarsson
left a comment
There was a problem hiding this comment.
Good idea to add this! lgtm
khintz
approved these changes
Dec 2, 2024
khintz
left a comment
There was a problem hiding this comment.
This looks good. Except for the conflict which has to be fixed of course.
…into maint/readme-python-example-test
…/leifdenby/weather-model-graphs into maint/readme-python-example-test
21 tasks
…into maint/readme-python-example-test
…into maint/readme-python-example-test
Member
Author
|
In fixing the tests I how now realised that our README example was incorrect 😆 I have now fixed that and in future the test implemented here should catch this. |
Contributor
|
Great, feel free to merge 😄 |
This was referenced Mar 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add missing test that ensures that python-code example in README executes without error.
#48 should be merged first (since that PR updates the
pre-commitgithub action, without that update the linting action fails)Describe your changes
Add a test which looks for python codeblocks in README and executes them. Having this test will ensure that python codeblock examples in README keep working as the codebase evolves.
No changes to dependencies.
Issue Link
In reviewing #32 I just realised that the example in the README hadn't been updated. I am adding this test to ensure that that should be caught be tests in future.
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee